README: reformat #26
README: reformat #26
Conversation
mkchoi212
commented
Jul 16, 2018
•
mkchoi212
commented
- Added overview table, logo
- Made grammatical/format changes
mkchoi212
force-pushed
the
beginner
branch
3 times, most recently
from
999ccbd
to
7c33b62
Compare
mkchoi212
changed the title
mkchoi212
force-pushed
the
beginner
branch
3 times, most recently
from
3de360e
to
9bc61cc
Compare
README.md
Outdated
| @@ -1,37 +1,90 @@ | |||
| # VLCKit | |||
| <img src="./logo.svg" alt="VLCKit logo" height="70" > | |||
There was a problem hiding this comment.
Needs to be uploaded to videolan.org/images
There was a problem hiding this comment.
do you have a preview for this ?
There was a problem hiding this comment.
never mind just saw it in your repo :D
There was a problem hiding this comment.
Here ya go :D https://github.com/mkchoi212/vlckit/blob/7172ae66c2d333d9adb4b7745fc4f73455954c91/README.md
btw for future references, you can go to
Files changed -> Viewto see file previews
README.md
Outdated
| - Xcode 9.0+ | ||
| - Cocoapods 1.4+ | ||
|
|
||
| ## Installation |
There was a problem hiding this comment.
Are there any other additional installation methods that should be covered? Like Carthage?
README.md
Outdated
| - Your media source is neither your mobile device nor a basic HTTP server, but a live stream hailing from some weird media server or even a raw DVB signal broadcasted on a local network | ||
| - and more! | ||
|
|
||
| ## Requirements |
There was a problem hiding this comment.
Not 100% on the Xcode / Cocoapods requirements
README.md
Outdated
|
|
||
| ## Requirements | ||
|
|
||
| - iOS 8.0 + / macOS 10.9+ / tvOS 9.0+ |
There was a problem hiding this comment.
tvOS 10.2 from what we have in the News unless felix commits weren't cherry-picked
README.md
Outdated
| - Your media source is neither your mobile device nor a basic HTTP server, but a live stream hailing from some weird media server or even a raw DVB signal broadcasted on a local network | ||
| - and more! | ||
|
|
||
| ## Requirements |
README.md
Outdated
| - Xcode 9.0+ | ||
| - Cocoapods 1.4+ | ||
|
|
||
| ## Installation |
README.md
Outdated
|
|
||
| ### GitLab Issues | ||
|
|
||
| You can look through the currently open issues on [GitLab] and choose the one that interests you the most. |
There was a problem hiding this comment.
you can link here to the issues :)
README.md
Outdated
| > Q. VLCKit being an open-source software, what does this mean for me and the end-user? And wasn’t MobileVLC removed from the App Store in 2011 for some crazy licensing reason? | ||
|
|
||
| VLCKit being open-source means that you get access to the whole stack. There is no blackbox. All the source code is there at your fingertips. No reverse-engineering is needed and there are no private APIs. | ||
|
|
There was a problem hiding this comment.
Since we don't explain why we got removed from the App Store can we remove this bit up here ? Also how open source works doesn't need to be in a README :) @fkuehne ? okay with that ?
README.md
Outdated
|
|
||
| ### Forum | ||
|
|
||
| If you ever need help, feel free to reach out. The [web forum] is always there for you. |
README.md
Outdated
|
|
||
| ### Issues | ||
|
|
||
| Did you find a bug and want to report it to us? You can create an issue on [GitLab] or on our [bug tracker]. |
README.md
Outdated
| [bug tracker]: <https://trac.videolan.org/vlc/> | ||
| [freenode]: <http://www.freenode.net/> | ||
| [freenode webchat]: <http://webchat.freenode.net/> | ||
| [VideoLAN wiki]: <https://wiki.videolan.org/VLCKit/> |
There was a problem hiding this comment.
I would move most of them inline
|
merged |
